Apidog MCP Server 설치 가이드

이 가이드는 Apidog MCP Server를 설치하는 방법을 세 가지 데이터 소스 옵션에 따라 단계별로 설명합니다.

사전 요구사항

Apidog MCP Server를 설치하기 전에 다음 항목이 필요합니다:

• Node.js 버전 18 이상: 최신 LTS 버전이 권장됩니다.
• MCP를 지원하는 IDE: Cursor 또는 Cline 플러그인이 포함된 VS Code와 같은 MCP 지원 IDE가 필요합니다.

옵션 1: Apidog 프로젝트를 데이터 소스로 사용하기

이 접근 방식은 Apidog 팀 내에서 API 사양에 접근할 때 이상적입니다.

1. API 접근 토큰 생성

1. Apidog를 열고 계정 설정 → API 접근 토큰으로 이동합니다.
2. 새 API 접근 토큰을 생성합니다.

2. Apidog 프로젝트 ID 가져오기

1. Apidog에서 목표 프로젝트를 엽니다.
2. 좌측 사이드바에서 "프로젝트 설정"을 클릭합니다.
3. "기본 설정"에서 프로젝트 ID를 복사합니다.

3. IDE에서 MCP 구성 설정

IDE의 MCP 구성을 열고 다음 구성을 추가합니다 (플레이스홀더를 실제 값으로 교체):

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--project=<project-id>"
      ],
      "env": {
        "APIDOG_ACCESS_TOKEN": "<access-token>"
      }
    }
  }
}

4. 구성 확인

AI에게 API 사양을 MCP를 통해 가져오도록 요청하여 구성을 확인합니다.

옵션 2: 온라인 API 문서를 데이터 소스로 사용하기

이 접근 방식은 Apidog를 통해 게시된 공개 API 문서에 접근할 필요가 있을 때 유용합니다.

1. MCP 서비스 활성화

1. Apidog 프로젝트로 이동합니다.
2. 문서 공유 → 문서 사이트 게시 → LLM 친화적인 기능으로 이동합니다.
3. "MCP" 서비스를 활성화합니다.

2. 구성 파일 가져오기

1. 온라인 문서에 접근합니다.
2. "Vibe Coding(via MCP)" 버튼을 클릭합니다.
3. 제공된 구성을 복사합니다.

3. IDE에서 MCP 설정

복사한 구성으로 IDE의 MCP 설정을 구성합니다:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

4. 연결 테스트

AI에게 API 문서를 MCP를 통해 가져오도록 요청하여 연결을 테스트합니다.

옵션 3: Swagger/OpenAPI 파일을 데이터 소스로 사용하기

이 옵션은 Apidog 프로젝트와는 독립적으로 로컬 또는 온라인 Swagger/OpenAPI 파일로 작업할 때 적합합니다.

1. OpenAPI 파일 준비

• Swagger/OpenAPI 파일의 URL 또는 로컬 경로를 확보합니다.
• 지원되는 형식은 JSON 및 YAML입니다.

2. IDE에서 MCP 구성 설정

다음 구성을 추가합니다 (플레이스홀더를 실제 파일 경로 또는 URL로 교체):

{
  "mcpServers": {
    "API specification": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--oas=https://petstore.swagger.io/v2/swagger.json"
      ]
    }
  }
}

3. 구성 확인

AI에게 API 문서를 MCP를 통해 가져오도록 요청하여 구성을 확인합니다.

문제 해결 팁

1. 노드 버전 확인: node -v 명령으로 Node.js 버전이 18 이상인지 확인합니다.
2. 권한 문제: 접근 토큰이 올바른 권한을 가지고 있는지 확인합니다.
3. 경로 문제: 파일 경로가 올바르게 지정되었는지 확인합니다.
4. 캐싱 이슈: Apidog에서 API 디자인을 업데이트한 경우, AI에게 MCP 데이터 소스를 새로 고치도록 요청해야 합니다.

다음 단계

설치가 완료되면 Apidog MCP 활용 가이드를 참고하여 Apidog MCP Server의 기능을 활용해 보세요.